<!DOCTYPE html>
<html>
<head>
	<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
	<meta name="generator" content="ApiGen 2.8.0" />

	<title>Class OpenBoleto\Agente | DOCUMENTAÇÃO DE SOFTWARE</title>

	<script type="text/javascript" src="resources/combined.js?882970337"></script>
	<script type="text/javascript" src="elementlist.js?3011337023"></script>
	<link rel="stylesheet" type="text/css" media="all" href="resources/bootstrap.min.css?260161822" />
	<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?2015443609" />

</head>

<body>
	<div id="navigation" class="navbar navbar-fixed-top">
		<div class="navbar-inner">
			<div class="container">
				<a href="index.html" class="brand">DOCUMENTAÇÃO DE SOFTWARE</a>
				<div class="nav-collapse">
					<ul class="nav">
						<li>
							<a href="namespace-OpenBoleto.html" title="Summary of OpenBoleto"><span>Namespace</span></a>
						</li>
						<li class="active">
<span>Class</span>						</li>

						<li class="divider-vertical"></li>

						<li>
							<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
						</li>


					</ul>
				</div>
			</div>
		</div>
	</div>

	<div id="left">
	<div id="menu">
		<form id="search" class="form-search">
			<input type="hidden" name="cx" value="" />
			<input type="hidden" name="ie" value="UTF-8" />
			<input type="text" name="q" class="search-query" placeholder="Search" />
		</form>


		<div id="groups">
			<h3>Namespaces</h3>
			<ul>
				<li><a href="namespace-None.html">None</a>
						</li>
				<li class="active"><a href="namespace-OpenBoleto.html">OpenBoleto<span></span></a>
						<ul>
				<li><a href="namespace-OpenBoleto.Banco.html">Banco</a>
						</li>
							</ul></li>
				<li><a href="namespace-PHP.html">PHP</a>
						</li>
			</ul>
		</div>


		<div id="elements">
			<h3>Classes</h3>
			<ul>
				<li class="active"><a href="class-OpenBoleto.Agente.html">Agente</a></li>
				<li><a href="class-OpenBoleto.BoletoAbstract.html">BoletoAbstract</a></li>
				<li><a href="class-OpenBoleto.BoletoFactory.html">BoletoFactory</a></li>
			</ul>



			<h3>Exceptions</h3>
			<ul>
				<li><a href="class-OpenBoleto.Exception.html">Exception</a></li>
			</ul>


		</div>
	</div>
</div>

<div id="splitter"></div>

<div id="right">
	<div id="rightInner">
<div id="content" class="class">
	<h1>Class Agente</h1>


	<div class="description">
	
<p>Classe de agente usuário do boleto</p>

	</div>









	<div class="alert alert-info">
		
		
		<b>Namespace:</b> <a href="namespace-OpenBoleto.html">OpenBoleto</a><br />
		<b>Package:</b> OpenBoleto<br />

				<b>Copyright:</b>
				Copyright (c) 2013 Estrada Virtual (<a
href="http://www.estradavirtual.com.br">http://www.estradavirtual.com.br</a>)<br />
				<b>License:</b>
				<a href="MIT">License</a><br />
				<b>Author:</b>
				Daniel Garajau &lt;<a
href="http://github.com/kriansa">http://github.com/kriansa</a>&gt;<br />
				<b>Version:</b>
				1.0<br />
		<b>Located at</b> <a href="source-class-OpenBoleto.Agente.html#30-255" title="Go to source code">openBoleto/src/OpenBoleto/Agente.php</a><br />
	</div>



		<h2>Methods summary</h2>
		<table class="summary table table-bordered table-striped" id="methods">
		<tr data-order="__construct" id="___construct">

			<td class="attributes"><code>
				 public 
				
				
				</code>
			</td>

			<td class="name"><div>
			<a class="anchor" href="#___construct">#</a>
			<code><a href="source-class-OpenBoleto.Agente.html#71-89" title="Go to source code">__construct</a>( <span>string <var>$nome</var></span>, <span>string <var>$documento</var></span>, <span>string <var>$endereco</var> = <span class="php-keyword1">null</span></span>, <span>string <var>$cep</var> = <span class="php-keyword1">null</span></span>, <span>string <var>$cidade</var> = <span class="php-keyword1">null</span></span>, <span>string <var>$uf</var> = <span class="php-keyword1">null</span></span> )</code>

			<div class="description short">
				
<p>Construtor</p>

			</div>

			<div class="description detailed hidden">
				
<p>Construtor</p>



					<h4>Parameters</h4>
					<div class="list"><dl>
						<dt><var>$nome</var></dt>
						<dd><code>string</code><br>$nome</dd>
						<dt><var>$documento</var></dt>
						<dd><code>string</code><br>$documento</dd>
						<dt><var>$endereco</var></dt>
						<dd><code>string</code><br>$endereco</dd>
						<dt><var>$cep</var></dt>
						<dd><code>string</code><br>$cep</dd>
						<dt><var>$cidade</var></dt>
						<dd><code>string</code><br>$cidade</dd>
						<dt><var>$uf</var></dt>
						<dd><code>string</code><br>$uf</dd>
					</dl></div>





			</div>
			</div></td>
		</tr>
		<tr data-order="setCep" id="_setCep">

			<td class="attributes"><code>
				 public 
				
				
				</code>
			</td>

			<td class="name"><div>
			<a class="anchor" href="#_setCep">#</a>
			<code><a href="source-class-OpenBoleto.Agente.html#91-99" title="Go to source code">setCep</a>( <span>string <var>$cep</var></span> )</code>

			<div class="description short">
				
<p>Define o CEP</p>

			</div>

			<div class="description detailed hidden">
				
<p>Define o CEP</p>



					<h4>Parameters</h4>
					<div class="list"><dl>
						<dt><var>$cep</var></dt>
						<dd><code>string</code><br>$cep</dd>
					</dl></div>





			</div>
			</div></td>
		</tr>
		<tr data-order="getCep" id="_getCep">

			<td class="attributes"><code>
				 public 
				string
				
				</code>
			</td>

			<td class="name"><div>
			<a class="anchor" href="#_getCep">#</a>
			<code><a href="source-class-OpenBoleto.Agente.html#101-109" title="Go to source code">getCep</a>( )</code>

			<div class="description short">
				
<p>Retorna o CEP</p>

			</div>

			<div class="description detailed hidden">
				
<p>Retorna o CEP</p>




					<h4>Returns</h4>
					<div class="list">
						<code>string</code><br />
					</div>




			</div>
			</div></td>
		</tr>
		<tr data-order="setCidade" id="_setCidade">

			<td class="attributes"><code>
				 public 
				
				
				</code>
			</td>

			<td class="name"><div>
			<a class="anchor" href="#_setCidade">#</a>
			<code><a href="source-class-OpenBoleto.Agente.html#111-119" title="Go to source code">setCidade</a>( <span>string <var>$cidade</var></span> )</code>

			<div class="description short">
				
<p>Define a cidade</p>

			</div>

			<div class="description detailed hidden">
				
<p>Define a cidade</p>



					<h4>Parameters</h4>
					<div class="list"><dl>
						<dt><var>$cidade</var></dt>
						<dd><code>string</code><br>$cidade</dd>
					</dl></div>





			</div>
			</div></td>
		</tr>
		<tr data-order="getCidade" id="_getCidade">

			<td class="attributes"><code>
				 public 
				string
				
				</code>
			</td>

			<td class="name"><div>
			<a class="anchor" href="#_getCidade">#</a>
			<code><a href="source-class-OpenBoleto.Agente.html#121-129" title="Go to source code">getCidade</a>( )</code>

			<div class="description short">
				
<p>Retorna a cidade</p>

			</div>

			<div class="description detailed hidden">
				
<p>Retorna a cidade</p>




					<h4>Returns</h4>
					<div class="list">
						<code>string</code><br />
					</div>




			</div>
			</div></td>
		</tr>
		<tr data-order="setDocumento" id="_setDocumento">

			<td class="attributes"><code>
				 public 
				
				
				</code>
			</td>

			<td class="name"><div>
			<a class="anchor" href="#_setDocumento">#</a>
			<code><a href="source-class-OpenBoleto.Agente.html#131-139" title="Go to source code">setDocumento</a>( <span>string <var>$documento</var></span> )</code>

			<div class="description short">
				
<p>Define o documento (CPF ou CNPJ)</p>

			</div>

			<div class="description detailed hidden">
				
<p>Define o documento (CPF ou CNPJ)</p>



					<h4>Parameters</h4>
					<div class="list"><dl>
						<dt><var>$documento</var></dt>
						<dd><code>string</code><br>$documento</dd>
					</dl></div>





			</div>
			</div></td>
		</tr>
		<tr data-order="getDocumento" id="_getDocumento">

			<td class="attributes"><code>
				 public 
				string
				
				</code>
			</td>

			<td class="name"><div>
			<a class="anchor" href="#_getDocumento">#</a>
			<code><a href="source-class-OpenBoleto.Agente.html#141-149" title="Go to source code">getDocumento</a>( )</code>

			<div class="description short">
				
<p>Retorna o documento (CPF ou CNPJ)</p>

			</div>

			<div class="description detailed hidden">
				
<p>Retorna o documento (CPF ou CNPJ)</p>




					<h4>Returns</h4>
					<div class="list">
						<code>string</code><br />
					</div>




			</div>
			</div></td>
		</tr>
		<tr data-order="setEndereco" id="_setEndereco">

			<td class="attributes"><code>
				 public 
				
				
				</code>
			</td>

			<td class="name"><div>
			<a class="anchor" href="#_setEndereco">#</a>
			<code><a href="source-class-OpenBoleto.Agente.html#151-159" title="Go to source code">setEndereco</a>( <span>string <var>$endereco</var></span> )</code>

			<div class="description short">
				
<p>Define o endereço</p>

			</div>

			<div class="description detailed hidden">
				
<p>Define o endereço</p>



					<h4>Parameters</h4>
					<div class="list"><dl>
						<dt><var>$endereco</var></dt>
						<dd><code>string</code><br>$endereco</dd>
					</dl></div>





			</div>
			</div></td>
		</tr>
		<tr data-order="getEndereco" id="_getEndereco">

			<td class="attributes"><code>
				 public 
				string
				
				</code>
			</td>

			<td class="name"><div>
			<a class="anchor" href="#_getEndereco">#</a>
			<code><a href="source-class-OpenBoleto.Agente.html#161-169" title="Go to source code">getEndereco</a>( )</code>

			<div class="description short">
				
<p>Retorna o endereço</p>

			</div>

			<div class="description detailed hidden">
				
<p>Retorna o endereço</p>




					<h4>Returns</h4>
					<div class="list">
						<code>string</code><br />
					</div>




			</div>
			</div></td>
		</tr>
		<tr data-order="setNome" id="_setNome">

			<td class="attributes"><code>
				 public 
				
				
				</code>
			</td>

			<td class="name"><div>
			<a class="anchor" href="#_setNome">#</a>
			<code><a href="source-class-OpenBoleto.Agente.html#171-179" title="Go to source code">setNome</a>( <span>string <var>$nome</var></span> )</code>

			<div class="description short">
				
<p>Define o nome</p>

			</div>

			<div class="description detailed hidden">
				
<p>Define o nome</p>



					<h4>Parameters</h4>
					<div class="list"><dl>
						<dt><var>$nome</var></dt>
						<dd><code>string</code><br>$nome</dd>
					</dl></div>





			</div>
			</div></td>
		</tr>
		<tr data-order="getNome" id="_getNome">

			<td class="attributes"><code>
				 public 
				string
				
				</code>
			</td>

			<td class="name"><div>
			<a class="anchor" href="#_getNome">#</a>
			<code><a href="source-class-OpenBoleto.Agente.html#181-189" title="Go to source code">getNome</a>( )</code>

			<div class="description short">
				
<p>Retorna o nome</p>

			</div>

			<div class="description detailed hidden">
				
<p>Retorna o nome</p>




					<h4>Returns</h4>
					<div class="list">
						<code>string</code><br />
					</div>




			</div>
			</div></td>
		</tr>
		<tr data-order="setUf" id="_setUf">

			<td class="attributes"><code>
				 public 
				
				
				</code>
			</td>

			<td class="name"><div>
			<a class="anchor" href="#_setUf">#</a>
			<code><a href="source-class-OpenBoleto.Agente.html#191-199" title="Go to source code">setUf</a>( <span>string <var>$uf</var></span> )</code>

			<div class="description short">
				
<p>Define a UF</p>

			</div>

			<div class="description detailed hidden">
				
<p>Define a UF</p>



					<h4>Parameters</h4>
					<div class="list"><dl>
						<dt><var>$uf</var></dt>
						<dd><code>string</code><br>$uf</dd>
					</dl></div>





			</div>
			</div></td>
		</tr>
		<tr data-order="getUf" id="_getUf">

			<td class="attributes"><code>
				 public 
				string
				
				</code>
			</td>

			<td class="name"><div>
			<a class="anchor" href="#_getUf">#</a>
			<code><a href="source-class-OpenBoleto.Agente.html#201-209" title="Go to source code">getUf</a>( )</code>

			<div class="description short">
				
<p>Retorna a UF</p>

			</div>

			<div class="description detailed hidden">
				
<p>Retorna a UF</p>




					<h4>Returns</h4>
					<div class="list">
						<code>string</code><br />
					</div>




			</div>
			</div></td>
		</tr>
		<tr data-order="getNomeDocumento" id="_getNomeDocumento">

			<td class="attributes"><code>
				 public 
				string
				
				</code>
			</td>

			<td class="name"><div>
			<a class="anchor" href="#_getNomeDocumento">#</a>
			<code><a href="source-class-OpenBoleto.Agente.html#211-223" title="Go to source code">getNomeDocumento</a>( )</code>

			<div class="description short">
				
<p>Retorna o nome e o documento formatados</p>

			</div>

			<div class="description detailed hidden">
				
<p>Retorna o nome e o documento formatados</p>




					<h4>Returns</h4>
					<div class="list">
						<code>string</code><br />
					</div>




			</div>
			</div></td>
		</tr>
		<tr data-order="getTipoDocumento" id="_getTipoDocumento">

			<td class="attributes"><code>
				 public 
				string
				
				</code>
			</td>

			<td class="name"><div>
			<a class="anchor" href="#_getTipoDocumento">#</a>
			<code><a href="source-class-OpenBoleto.Agente.html#225-241" title="Go to source code">getTipoDocumento</a>( )</code>

			<div class="description short">
				
<p>Retorna se o tipo do documento é CPF ou CNPJ ou Documento</p>

			</div>

			<div class="description detailed hidden">
				
<p>Retorna se o tipo do documento é CPF ou CNPJ ou Documento</p>




					<h4>Returns</h4>
					<div class="list">
						<code>string</code><br />
					</div>




			</div>
			</div></td>
		</tr>
		<tr data-order="getCepCidadeUf" id="_getCepCidadeUf">

			<td class="attributes"><code>
				 public 
				string
				
				</code>
			</td>

			<td class="name"><div>
			<a class="anchor" href="#_getCepCidadeUf">#</a>
			<code><a href="source-class-OpenBoleto.Agente.html#243-254" title="Go to source code">getCepCidadeUf</a>( )</code>

			<div class="description short">
				
<p>Retorna o endereço formatado para a linha 2 de endereço</p>

			</div>

			<div class="description detailed hidden">
				
<p>Retorna o endereço formatado para a linha 2 de endereço</p>

<p>Ex: 71000-000 - Brasília - DF</p>




					<h4>Returns</h4>
					<div class="list">
						<code>string</code><br />
					</div>




			</div>
			</div></td>
		</tr>
		</table>



		<h3>Magic methods summary</h3>








		<h2>Properties summary</h2>
		<table class="summary table table-bordered table-striped" id="properties">
		<tr data-order="nome" id="$nome">
			<td class="attributes"><code>
				protected  
				string
			</code></td>

			<td class="name">
					<a href="source-class-OpenBoleto.Agente.html#41-44" title="Go to source code"><var>$nome</var></a>
			</td>
			<td class="description"><div>
				<a href="#$nome" class="anchor">#</a>

				<div class="description short">
					
				</div>

				<div class="description detailed hidden">
					

				</div>
			</div></td>
		</tr>
		<tr data-order="endereco" id="$endereco">
			<td class="attributes"><code>
				protected  
				string
			</code></td>

			<td class="name">
					<a href="source-class-OpenBoleto.Agente.html#46-49" title="Go to source code"><var>$endereco</var></a>
			</td>
			<td class="description"><div>
				<a href="#$endereco" class="anchor">#</a>

				<div class="description short">
					
				</div>

				<div class="description detailed hidden">
					

				</div>
			</div></td>
		</tr>
		<tr data-order="cep" id="$cep">
			<td class="attributes"><code>
				protected  
				string
			</code></td>

			<td class="name">
					<a href="source-class-OpenBoleto.Agente.html#51-54" title="Go to source code"><var>$cep</var></a>
			</td>
			<td class="description"><div>
				<a href="#$cep" class="anchor">#</a>

				<div class="description short">
					
				</div>

				<div class="description detailed hidden">
					

				</div>
			</div></td>
		</tr>
		<tr data-order="uf" id="$uf">
			<td class="attributes"><code>
				protected  
				string
			</code></td>

			<td class="name">
					<a href="source-class-OpenBoleto.Agente.html#56-59" title="Go to source code"><var>$uf</var></a>
			</td>
			<td class="description"><div>
				<a href="#$uf" class="anchor">#</a>

				<div class="description short">
					
				</div>

				<div class="description detailed hidden">
					

				</div>
			</div></td>
		</tr>
		<tr data-order="cidade" id="$cidade">
			<td class="attributes"><code>
				protected  
				string
			</code></td>

			<td class="name">
					<a href="source-class-OpenBoleto.Agente.html#61-64" title="Go to source code"><var>$cidade</var></a>
			</td>
			<td class="description"><div>
				<a href="#$cidade" class="anchor">#</a>

				<div class="description short">
					
				</div>

				<div class="description detailed hidden">
					

				</div>
			</div></td>
		</tr>
		<tr data-order="documento" id="$documento">
			<td class="attributes"><code>
				protected  
				string
			</code></td>

			<td class="name">
					<a href="source-class-OpenBoleto.Agente.html#66-69" title="Go to source code"><var>$documento</var></a>
			</td>
			<td class="description"><div>
				<a href="#$documento" class="anchor">#</a>

				<div class="description short">
					
				</div>

				<div class="description detailed hidden">
					

				</div>
			</div></td>
		</tr>
		</table>






</div>
	</div>

	<div id="footer">
		DOCUMENTAÇÃO DE SOFTWARE API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
	</div>
</div>
</body>
</html>
